Create Dynamic PIX QR Code with Due Date

The dynamic QR Code with a due date is used for payments where the originator is known and it is desirable to facilitate payment, allowing the addition of deadlines, discounts, fines, and interest. This QR Code is typically used as a replacement for bank slips.

Request

ENDPOINT

/account/ACCOUNT_KEY/alias/ALIAS_KEY/qrcode

METHOD

POST

Request Body: Dynamic QR Code with Due Date

{
  "request_control_key": "8a923886-afce-4116-ac1f-69bdffcf8da9",
  "qr_code_type": "dynamic_term",
  "amount": 10.25,
  "receiver_conciliation_id": "01GVGV9NXBCY287Z6CJ4S0ENW9",
  "payer_document_number": "00000000000000",
  "payer_name": "Random",
  "payer_request": "Payment for order XXXXXXXXXX",
  "pix_key": "3d7d6a2b-f72f-44c7-bb20-79a94dff5954",
  "expiration_date": "2023-03-25",
  "max_payment_days": 128,
  "fine_amount": 3,
  "interest_amount": 2,
  "rebate_amount": 1,
  "discounts": [],
  "additional_data": [
    {
      "key_name": "merchant_name",
      "value": "Lojas Costa S.A."
    }
  ],
}

Body Params

Field	Type	Description	Characters
`request_control_key` *	string	Unique UUID4 identifier of the request.	-
`qr_code_type` *	string	Type of the dynamic QR Code. `"dynamic_term"` or `"dynamic_instant"`	-
`amount` *	float	QR Code amount before calculating discounts or interest and fines.	-
`receiver_conciliation_id` *	string	QR Code identifier for reconciliation after payment.	-
`payer_document_number` *	string	Payer's CPF/ CNPJ.	-
`payer_name` *	string	Payer's name.	-
`payer_request` *	string	Message to the payer.	-
`pix_key` *	string	PIX key representing the destination account of the transaction.	-
`expiration_date` *	date	Due date of the charge (in the format "YYYY-MM-DD").	-
`max_payment_days` *	int32	Maximum days for paying the charge.	-
`fine_amount` *	float	Absolute fine amount after the due date.	-
`interest_amount` *	float	Absolute value per day of delay after the due date. If paid one day after the due date, the total amount will be the original value + fine.	-
`rebate_amount` *	float	Absolute rebate amount before payment.	-
`discounts`	array of objects	Discount settings.	-
`additional_data`	array of objects	Extra information for the QR Code used for reconciliations.	-

Object additional_data

Field	Type	Description	Characters
`key_name` *	string	Name of the field	-
`value` *	string	Value of the field	-

Object discount

Field	Type	Description	Characters
`discount_value` *	float	Discount amount.	-
`discount_number`	int32	Order in which the discount should be applied.	-
`discount_limit_date` *	string	Discount limit date.	-

Response

STATUS

201 Created

Response Body: Create dynamic QR Code with Due Date

{
  "request_control_key": "037b46b1-0c67-4c0d-aac3-1e395dfdcb10",
  "qr_code_key": "d74bf12a-9243-4bfa-9b00-6b63755b6555",
  "qr_code_status": "active",
  "base_64_payload": "<BASE64 DA URI DO PIX COPIA E COLA>",
  "created_at": "2023-03-03T12:04:06.179Z",
}

Field	Type	Description	Characters
`request_control_key` *	string	Unique UUID4 identifier of the request.	-
`qr_code_key` *	string	QR Code identifier for future requests.	-
`qr_code_status` *	string	QR Code status in the system.	"active": default for creation.
`base_64_payload` *	string	URL of the QR Code for payment in base64.	-
`created_at` *	datetime	Date and time the QR Code was created in the system.	-

Object qr_code_status

Field	Type	Description	Characters
`active`	string	QR Code is active and available for payment.	-
`finished`	string	QR Code has been paid.	-
`written_off`	string	QR Code has been canceled by the client.	-
`bank_written_off`	string	QR Code was automatically canceled due to expiration.	-

STATUS

400

Response Body

{
    "title": "Bad Request",
    "description": "Invalid payload for QR Code creation.",
    "translation": "Payload inválido para a criação de QR Code.",
    "code": "QRI000003"
}

Create Dynamic PIX QR Code with Due Date

Request​

Body Params​

Object additional_data​

Object discount​

Response​

Object qr_code_status​